FrameLib_Parameters::Serial Class Reference

a set of tagged parameter values using external non-owned memory. More...

#include <FrameLib_Parameters.h>

Inheritance diagram for FrameLib_Parameters::Serial:

Classes
class	Iterator
	an iterator for the items in a Serial. More...

Public Member Functions
Iterator	begin () const
Iterator	end () const
	Serial (BytePointer ptr, size_t size)
	Serial ()
	Serial (const Serial &)=delete
Serial &	operator= (const Serial &)=delete
size_t	getSize (const char *tag) const
size_t	getVectorSize (const char *tag) const
void	write (const Serial *serialised)
void	write (const FrameLib_Parameters *params)
void	write (const Serial::Iterator &it)
void	write (const char *tag, const char *str)
void	write (const char *tag, const double *values, size_t N)
void	read (FrameLib_Parameters *parameters) const
size_t	read (const char *tag, double *output, unsigned long size) const
bool	read (const char *tag, FrameLib_Parameters *parameters) const
Iterator	find (const char *tag) const
unsigned long	numTags () const
size_t	size () const
void	clear ()

Static Public Member Functions
static size_t	calcSize (const Serial *serialised)
static size_t	calcSize (const FrameLib_Parameters *params)
static size_t	calcSize (const char *tag, const char *str)
static size_t	calcSize (const char *tag, size_t N)
static size_t	alignSize (size_t size)
static size_t	inPlaceSize (size_t size)
static Serial *	newInPlace (void *ptr, size_t size)

Static Public Attributes
static const size_t	alignment = sizeof(double)

Protected Member Functions
bool	checkSize (size_t writeSize)

Protected Attributes
BytePointer	mPtr
size_t	mSize
size_t	mMaxSize
unsigned long	mNumTags

Detailed Description

a set of tagged parameter values using external non-owned memory.

Constructor & Destructor Documentation

Serial() [1/3]

FrameLib_Parameters::Serial::Serial	(	BytePointer	ptr,
		size_t	size
	)

Serial() [2/3]

FrameLib_Parameters::Serial::Serial

(

)

Serial() [3/3]

FrameLib_Parameters::Serial::Serial ( const Serial &  )

delete

Member Function Documentation

alignSize()

static size_t FrameLib_Parameters::Serial::alignSize ( size_t  size )

inlinestatic

begin()

Iterator FrameLib_Parameters::Serial::begin ( ) const

inline

calcSize() [1/4]

static size_t FrameLib_Parameters::Serial::calcSize ( const Serial *  serialised )

inlinestatic

calcSize() [2/4]

size_t FrameLib_Parameters::Serial::calcSize ( const FrameLib_Parameters *  params )

static

calcSize() [3/4]

static size_t FrameLib_Parameters::Serial::calcSize ( const char *  tag, const char *  str  )

inlinestatic

calcSize() [4/4]

static size_t FrameLib_Parameters::Serial::calcSize ( const char *  tag, size_t  N  )

inlinestatic

checkSize()

bool FrameLib_Parameters::Serial::checkSize ( size_t  writeSize )

protected

clear()

void FrameLib_Parameters::Serial::clear ( )

inline

end()

Iterator FrameLib_Parameters::Serial::end ( ) const

inline

find()

FrameLib_Parameters::Serial::Iterator FrameLib_Parameters::Serial::find

(

const char *

tag

)

const

getSize()

size_t FrameLib_Parameters::Serial::getSize

(

const char *

tag

)

const

getVectorSize()

size_t FrameLib_Parameters::Serial::getVectorSize

(

const char *

tag

)

const

inPlaceSize()

static size_t FrameLib_Parameters::Serial::inPlaceSize ( size_t  size )

inlinestatic

newInPlace()

static Serial* FrameLib_Parameters::Serial::newInPlace ( void *  ptr, size_t  size  )

inlinestatic

numTags()

unsigned long FrameLib_Parameters::Serial::numTags ( ) const

inline

operator=()

Serial& FrameLib_Parameters::Serial::operator= ( const Serial &  )

delete

read() [1/3]

void FrameLib_Parameters::Serial::read

(

FrameLib_Parameters *

parameters

)

const

read() [2/3]

size_t FrameLib_Parameters::Serial::read	(	const char *	tag,
		double *	output,
		unsigned long	size
	)		const

read() [3/3]

bool FrameLib_Parameters::Serial::read	(	const char *	tag,
		FrameLib_Parameters *	parameters
	)		const

size()

size_t FrameLib_Parameters::Serial::size ( ) const

inline

write() [1/5]

void FrameLib_Parameters::Serial::write

(

const Serial *

serialised

)

write() [2/5]

void FrameLib_Parameters::Serial::write

(

const FrameLib_Parameters *

params

)

write() [3/5]

void FrameLib_Parameters::Serial::write

(

const Serial::Iterator &

it

)

write() [4/5]

void FrameLib_Parameters::Serial::write	(	const char *	tag,
		const char *	str
	)

write() [5/5]

void FrameLib_Parameters::Serial::write	(	const char *	tag,
		const double *	values,
		size_t	N
	)

Member Data Documentation

alignment

const size_t FrameLib_Parameters::Serial::alignment = sizeof(double)

static

mMaxSize

size_t FrameLib_Parameters::Serial::mMaxSize

protected

mNumTags

unsigned long FrameLib_Parameters::Serial::mNumTags

protected

mPtr

BytePointer FrameLib_Parameters::Serial::mPtr

protected

mSize

size_t FrameLib_Parameters::Serial::mSize

protected

---

The documentation for this class was generated from the following files:

• /Users/alexharker/Documents/Max Externals/FrameLib/FrameLib_Framework/FrameLib_Parameters.h
• /Users/alexharker/Documents/Max Externals/FrameLib/FrameLib_Framework/FrameLib_Parameters.cpp